ci(pre-commit): enforce conventional-commits message structure #164
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This adds pre-commit and ci checks to ensure that commit messages follow [`conventional-commits`](https://www.conventionalcommits.org/en/v1.0.0/). From their site: Conventional Commits is: `A specification for adding human and machine readable meaning to commit messages` Commit messages must follow the following format: ``` <type>[optional scope]: <description> [optional body] [optional footer(s)] ``` In general, this means that you will provide a topic: * feat * fix * ci * refactor Followed by a description. Following this standard allows for automatic semantic versioning and release note generation. * `.commitlintrc.yaml` - defines the commit message format for linting * `.cz.json` - configuration for [`commitizen-cli`](http://commitizen.github.io/cz-cli/)
greenkiwi
force-pushed
the
conventional-commits
branch
from
49a08be to
b3854ea
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds pre-commit and ci checks to ensure that commit messages follow
conventional-commits.From their site: Conventional Commits is:
A specification for adding human and machine readable meaning to commit messagesCommit messages must follow the following format:
In general, this means that you will provide a topic:
Followed by a description.
Following this standard allows for automatic semantic versioning and
release note generation.
.commitlintrc.yaml- defines the commit message format for linting.cz.json- configuration forcommitizen-cliDescription of the change
Type of change
Checklists
Development
Code review
Testing